<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaTreeMgrSelect: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="trees.html" title="Trees">
<link rel="prev" href="GdaTreeMgrLabel.html" title="GdaTreeMgrLabel">
<link rel="next" href="GdaTreeMgrSchemas.html" title="GdaTreeMgrSchemas">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GdaTreeMgrSelect.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdaTreeMgrSelect.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GdaTreeMgrSelect.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="trees.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaTreeMgrLabel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaTreeMgrSchemas.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaTreeMgrSelect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaTreeMgrSelect.top_of_page"></a>GdaTreeMgrSelect</span></h2>
<p>GdaTreeMgrSelect — A tree manager which creates a node for each row resulting from the execution of a SELECT statement</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="returnvalue">GdaTreeManager</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaTreeMgrSelect.html#gda-tree-mgr-select-new" title="gda_tree_mgr_select_new ()">gda_tree_mgr_select_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *</td>
<td class="property_name"><a class="link" href="GdaTreeMgrSelect.html#GdaTreeMgrSelect--connection" title="The “connection” property">connection</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> *</td>
<td class="property_name"><a class="link" href="GdaTreeMgrSelect.html#GdaTreeMgrSelect--params" title="The “params” property">params</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *</td>
<td class="property_name"><a class="link" href="GdaTreeMgrSelect.html#GdaTreeMgrSelect--statement" title="The “statement” property">statement</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdaTreeMgrSelect.html#GdaTreeMgrSelect-struct" title="struct GdaTreeMgrSelect">GdaTreeMgrSelect</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="GdaTreeManager.html" title="GdaTreeManager">GdaTreeManager</a>
        <span class="lineart">╰──</span> GdaTreeMgrSelect
</pre>
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libgda/gda-statement-extra.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.description"></a><h2>Description</h2>
<p>The <a class="link" href="GdaTreeMgrSelect.html" title="GdaTreeMgrSelect"><span class="type">GdaTreeMgrSelect</span></a> is a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object which executes a SELECT statement and
creates a node for each row in the result.</p>
<p>The <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> and SELECT <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> to be used need to be specified when the object is created.
If the SELECT statement to be used needs some parameters, then it is possible to give values to some of them
when constructing the object, but not necessary.</p>
<p>If the SELECT statement needs some parameters which have not been provided during the construction, then
these parameters will be fetched from the <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> below which the nodes will be placed (using
<a class="link" href="GdaTreeNode.html#gda-tree-node-fetch-attribute" title="gda_tree_node_fetch_attribute ()"><code class="function">gda_tree_node_fetch_attribute()</code></a>).</p>
<p>For each node created, an attribute is set for each column in the SELECT statement: the attribute name is
the column name and the attribute value is the value if that column.</p>
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-tree-mgr-select-new"></a><h3>gda_tree_mgr_select_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="returnvalue">GdaTreeManager</span></a> *
gda_tree_mgr_select_new (<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
                         <em class="parameter"><code><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *stmt</code></em>,
                         <em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> *params</code></em>);</pre>
<p>Creates a new <a class="link" href="GdaTreeMgrSelect.html" title="GdaTreeMgrSelect"><span class="type">GdaTreeMgrSelect</span></a> object which will add one tree node for each row in
the <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> resulting from the execution of <em class="parameter"><code>stmt</code></em>
.</p>
<div class="refsect3">
<a name="gda-tree-mgr-select-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stmt</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> object representing a SELECT statement</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>params</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> object representing fixed parameters which are to be used when executing <em class="parameter"><code>stmt</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-tree-mgr-select-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
<p class="since">Since: 4.2</p>
</div>
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaTreeMgrSelect-struct"></a><h3>struct GdaTreeMgrSelect</h3>
<pre class="programlisting">struct GdaTreeMgrSelect;</pre>
</div>
</div>
<div class="refsect1">
<a name="GdaTreeMgrSelect.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaTreeMgrSelect--connection"></a><h3>The <code class="literal">“connection”</code> property</h3>
<pre class="programlisting">  “connection”               <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *</pre>
<p>Connection to use.</p>
<p>Owner: GdaTreeMgrSelect</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaTreeMgrSelect--params"></a><h3>The <code class="literal">“params”</code> property</h3>
<pre class="programlisting">  “params”                   <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> *</pre>
<p>Parameters for the SELECT statement.</p>
<p>Owner: GdaTreeMgrSelect</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaTreeMgrSelect--statement"></a><h3>The <code class="literal">“statement”</code> property</h3>
<pre class="programlisting">  “statement”                <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *</pre>
<p>SELECT statement.</p>
<p>Owner: GdaTreeMgrSelect</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>